/*
 * Niiuzu
 * Copyright (C) 2011  Thierry Nowak
 * 
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later
 * version.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU General Public License along with
 * this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.niiuzu.shared.rpc;

import com.google.gwt.user.client.rpc.RemoteService;
import com.google.gwt.user.client.rpc.RemoteServiceRelativePath;
import com.niiuzu.shared.exception.ServiceRpcException;
import com.niiuzu.shared.model.FeedChannel;
import com.niiuzu.shared.model.FeedChannelGroup;
import com.niiuzu.shared.model.FeedEntry;
import com.niiuzu.shared.model.FeedStyle;

/**
 * Service dédié à la gestion des flux.
 */
@RemoteServiceRelativePath("feedService")
public interface FeedService extends RemoteService {

	/**
	 * Récupère les dernières entrées sur des flux RSS donnés.
	 * 
	 * @param channels
	 *            Flux RSS qui seront interrogés pour récupérer les nouvelles
	 *            entrées.
	 * 
	 * @throws ServiceRpcException
	 *             erreur technique survenue durant le traitement.
	 */
	FeedEntry[] recoverFeedEntries(FeedChannel[] channels)
			throws ServiceRpcException;

	/**
	 * Crée un nouveau flux et l'enregistre dans le magasin de données.
	 * 
	 * @param link
	 *            URL pointant vers le flux.
	 * @param name
	 *            nom donné au flux.
	 * @param channelGroup
	 *            thème du flux.
	 * 
	 * @return nouvelle instance de {@link FeedChannel}.
	 * 
	 * @throws ServiceRpcException
	 *             erreur technique survenue durant le traitement.
	 */
	FeedChannel createChannel(String link, String name,
			FeedChannelGroup channelGroup) throws ServiceRpcException;

	/**
	 * Crée un nouveau thème et l'enregistre dans le magasin de données.
	 * 
	 * @param name
	 *            nom du thème.
	 * @param style
	 *            style du thème
	 * 
	 * @return nouvelle instance de {@link FeedChannelGroup}.
	 * 
	 * @throws ServiceRpcException
	 *             erreur technique survenue durant le traitement.
	 */
	FeedChannelGroup createChannelGroup(String name, FeedStyle style)
			throws ServiceRpcException;

	/**
	 * Supprime le flux du magasin de données.
	 * 
	 * @param channel
	 *            flux à supprimer.
	 * 
	 * @throws ServiceRpcException
	 *             erreur technique survenue durant le traitement.
	 */
	void removeChannel(FeedChannel channel) throws ServiceRpcException;

	/**
	 * Supprime le thème du magasin de données.
	 * 
	 * @param channelGroup
	 *            thème à supprimer.
	 * 
	 * @throws ServiceRpcException
	 *             erreur technique survenue durant le traitement.
	 */
	void removeChannelGroup(FeedChannelGroup channelGroup)
			throws ServiceRpcException;
}
